Skip to content

fix: workflow page admonitions, diagram, and links#190

Merged
rdmueller merged 4 commits into
LLM-Coding:mainfrom
raifdmueller:feat/workflow-docs-page
Mar 14, 2026
Merged

fix: workflow page admonitions, diagram, and links#190
rdmueller merged 4 commits into
LLM-Coding:mainfrom
raifdmueller:feat/workflow-docs-page

Conversation

@raifdmueller

@raifdmueller raifdmueller commented Mar 14, 2026

Copy link
Copy Markdown
Contributor

Summary

Follow-up fixes for the Spec-Driven Workflow page (#189):

  • Add Font Awesome 4.7 CDN to index.html for admonition icons
  • Add complete admonition styles (note, tip, warning, caution, important) to asciidoctor-scoped.css
  • Restore original workflow overview diagram (horizontal PlantUML layout with feedback loop)
  • Fix image path rewriting in copyHtmlDoc for SPA context
  • Fix broken AGENTS.md link (was incorrectly linking to https://agents.md)
  • Set lang="de" on German HTML page
  • Add SRI integrity hashes for CDN resources

Test plan

  • Verify admonition blocks show icons (info, warning, important, tip)
  • Verify workflow diagram displays correctly under "Workflow Overview"
  • Verify all anchor links work (click through to catalog entries)
  • Verify AGENTS.md is rendered as code, not a link
  • Run npm test and npm run test:e2e

🤖 Generated with Claude Code

Summary by CodeRabbit

Versionshinweise

  • Neue Funktionen

    • Workflow-Diagramm zur Dokumentation hinzugefügt für verbesserte Visualisierung des Prozesses.
  • Dokumentation

    • AGENTS.md-Beschreibung erweitert mit zusätzlichen Informationen zur Speicherfunktion des Projekts.
  • Style

    • Verbessertes Styling für Hinweis- und Warnblöcke mit Icons und verbesserter Formatierung.

raifdmueller and others added 4 commits March 14, 2026 12:15
- Add Font Awesome 4.7 CDN link with SRI to index.html
- Add complete admonition icon styles (note, tip, warning, caution,
  important) to asciidoctor-scoped.css with proper table layout
- Fix broken AGENTS.md link (was incorrectly linking to https://agents.md)

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Replaces the missing workflow-diagram.png with an inline SVG showing
all 5 phases, key artifacts, the implementation loop, and cross-cutting
concerns.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
- Generate workflow-diagram.png from PlantUML showing all 5 phases
  with activity diagram layout (requirements, architecture, planning,
  implementation loop, quality assurance)
- Fix image path rewriting in copyHtmlDoc for SPA context
- Copy workflow-diagram.png asset during build
- Add gitignore exception for docs/workflow-diagram.png

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Replaces the generated PlantUML diagram with the original horizontal
layout showing all 5 phases with the "update spec?" feedback loop.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@coderabbitai

coderabbitai Bot commented Mar 14, 2026

Copy link
Copy Markdown
Contributor

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yml

Review profile: CHILL

Plan: Pro

Run ID: d7086464-684d-4c97-aad6-c1487b591192

📥 Commits

Reviewing files that changed from the base of the PR and between 03ba180 and 0b87823.

⛔ Files ignored due to path filters (1)
  • docs/workflow-diagram.png is excluded by !**/*.png
📒 Files selected for processing (6)
  • .gitignore
  • docs/spec-driven-workflow.de.html
  • docs/spec-driven-workflow.html
  • scripts/render-docs.js
  • website/index.html
  • website/src/styles/asciidoctor-scoped.css

Walkthrough

Die Änderungen führen ein Workflow-Diagramm in die Dokumentation ein und ergänzen es mit entsprechenden Styling-Updates. Ein neues Bildverzeichnis wird der .gitignore hinzugefügt, HTML-Dokumentationsdateien integrieren das Diagramm, Skripte werden für Bildpfad-Umschreibung und Asset-Verwaltung angepasst, Font-Awesome-Icons werden hinzugefügt und Admonition-Block-Styling wird erweitert.

Changes

Cohort / File(s) Zusammenfassung
Konfiguration und Assets
.gitignore
Neue Ignore-Regel für docs/workflow-diagram.png hinzugefügt, um die Diagramm-Bilddatei von der Versionskontrolle auszuschließen.
Dokumentation – Spec-Driven-Workflow
docs/spec-driven-workflow.html, docs/spec-driven-workflow.de.html
Workflow-Diagramm-Bildblock in die "Workflow-Übersicht" hinzugefügt; AGENTS.md-Beschreibung aktualisiert (Hyperlink entfernt in English-Version, erweiterte Beschreibung in German-Version).
Build- und Rendering-Logik
scripts/render-docs.js
Relative Bildpfade in HTML um docs/-Präfix angereichert; neuer Asset-Kopier-Schritt für docs/workflow-diagram.png nach website/public/docs/workflow-diagram.png hinzugefügt.
Website-Styling und Markup
website/index.html
Font-Awesome-Stylesheet-Link im Head hinzugefügt für Admonition-Icons.
Admonition-Block-Styling
website/src/styles/asciidoctor-scoped.css
Umfassende Umgestaltung der .admonitionblock-Styles mit tabellenbasiertem Layout, Icon-Unterstützung (::before mit Font-Awesome), Rändern, Rahmenradius und feiner Abstimmung von Padding und Typografie.

Geschätzter Code-Review-Aufwand

🎯 3 (Moderat) | ⏱️ ~22 Minuten

Möglicherweise verwandte PRs

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
📝 Coding Plan
  • Generate coding plan for human review comments

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@rdmueller rdmueller merged commit e5a6a83 into LLM-Coding:main Mar 14, 2026
6 of 7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants